Skip to content

Update guide.md - #220

Merged
GBKS merged 9 commits into
BitcoinDesign:masterfrom
pavlenex:kenedits
Apr 29, 2021
Merged

GBKS merged 9 commits into
BitcoinDesign:masterfrom
pavlenex:kenedits

Conversation

@pavlenex

@pavlenex pavlenex commented Apr 12, 2021 •

Copy link
Copy Markdown
Contributor

Co-Authored-By: @sqcken

This PR takes a deep look at Gude.md and is the first step towards in-depth proofreading and restructure.
Part of #202

This is all work by @sqcken. I am just 🤖 transferring things over to GH in chunks.

Please review these ASAP since we'll push these changes regularly to avoid conflicts with other PR's.

The process will be to push 1 PR per page.

The goal besides proofreading and simplifying is to remove duplication and fluff, which aims for conciseness.

Before

Screenshot 2021-04-12 at 19 52 51

After the PR

Screenshot 2021-04-12 at 19 55 46

Co-Authored-By: sqcken <70726704+sqcken@users.noreply.github.com>
Comment thread guide.md Resolved
Comment thread guide.md
**Bitcoin is a global payment protocol that anyone with Internet access can participate in and contribute to. However, because bitcoin’s use cases are as vast as its user base, building bitcoin applications can be complicated.**

This guide was built on that very idea. Like a travel guide, it provides an introduction to a “foreign place”, shows you the highlights and tells you some of the best stories. It provides facts and maps to figure out how to get around, ideas for tours and things to do. Whether you end up taking the official museum tour, clubbing all night or go on shopping sprees is still your choice. Note that these are guides, not mandates. Just like in a foreign city, you can choose to go off the path, and forge a new direction. Others may just follow in the future.
We designed this guide to help anyone navigate those complexities—regardless of where they live or work. We can’t imagine every possible use case, but we can help you build for them.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The travel guide metaphor is visualized in the page header. So my vote would be for keeping it in the text as well. I also like the new copy, maybe combine the two?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the "map" is evident from it being called a guide and a map being at the top. Otherwise it's see/say. I have some doubts about the metaphor itself and suspect that it's clearer without.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you not like about the metaphor? It got a really strong positive response from people, which was a signal for me to put it in focus.

@danielnordh danielnordh Apr 16, 2021 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I liked the metaphor when we were describing the 'guide project'.
Now that I read/review the whole guide it feels we can be shorter in our writing in general.
Let people get to the content instead of describing what they will get. So I'm ok with moving on from the metaphor.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tend to agree, I was the biggest fan of the metaphor but after reading a guide a bit myself, I completely agree with what Daniel is saying above. We need to be a bit more concise. How about we remove it, and if we feel nostalgic we can always return it or we can put it on GitHub somewhere, repo description or something?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consensus is to remove it, so let's go with that. Thanks for the input.

Comment thread guide.md Resolved
Comment thread guide.md Resolved
Comment thread guide.md Resolved
Comment thread guide.md Outdated
- [Private key management]({{ '/guide/private-key-management/introduction/' | relative_url }}) details the many techniques that can be used to store private keys
- [Payments]({{ '/guide/payments/' | relative_url }}) covers the complexities encountered when sending and receiving bitcoin
- [Foundations]({{ '/guide/foundations/' | relative_url }}) highlights principles and other fundamentals designing Bitcoin products
- [Case studies]({{ '/guide/case-studies/' | relative_url }}) explores wire framing, designing, and prototyping for diverse use cases

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turning the text around like this doesn't work. It's not an exploration of wire frames and other tools. It's an exploration of design solutions to certain use cases, using the means of wire framing and other tools.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"lays out how to use wire frames and other tools to implement specific design-based use cases"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still not right. It's not how about which tools to use and how to use them. The section presents solutions to specific use cases. The solutions are not just described, but presented with design mock-ups, wire frames, prototypes, etc.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So what do we do here then? Any concrete suggestion I can commit, as this is the only blocker to get this one merged.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GBKS Any thoughts on a next step here? Not 100% sure on what we’re trying to accomplish. If this is the only blocker, feel free to drop in any thoughts, or leave as is, and I can drop in feedback if necessary.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ping @GBKS

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we have a better idea, happy to implement it, otherwise can revert as well, let's keep the PR's going this is really a minor blocker.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's revert it. Sorry for the late reply.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@GBKS done a01e45a

Comment thread guide.md Resolved
pavlenex and others added 2 commits April 13, 2021 18:23
Co-authored-by: Christoph Ono <chri@sto.ph>
Co-Authored-By: Christoph Ono <695901+GBKS@users.noreply.github.com>
Co-Authored-By: sqcken <70726704+sqcken@users.noreply.github.com>
@pavlenex

Copy link
Copy Markdown
Contributor Author

There seem to be two blockers to get this PR going:

  1. Removing the metaphor - there seems to be a very rough consensus, @GBKS do you feel strongly about keeping the metaphor?
  2. The Case Study text - Should we just revert and keep the old description in order to proceed or?

@pavlenex

Copy link
Copy Markdown
Contributor Author

Should be good to go now as both blockers got resolved via consensus.

@GBKS
GBKS merged commit 9ac25e4 into BitcoinDesign:master Apr 29, 2021
@pavlenex pavlenex mentioned this pull request May 6, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Copy Task is about improving text.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants